docs: inputs: add thread.ring_buffer.retry_limit option#2363
docs: inputs: add thread.ring_buffer.retry_limit option#2363jinyongchoi wants to merge 1 commit into
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (4)
📝 WalkthroughWalkthroughDocumentation updates to four input plugin guides adding the Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new thread.ring_buffer.retry_limit input configuration option (retry attempts before dropping data when the threaded ring buffer is full).
Changes:
- Documented
thread.ring_buffer.retry_limitfortail,opentelemetry,prometheus-textfile, andblobinputs. - Described behavior (max retries, 100ms wait per retry) and default value (
10).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| pipeline/inputs/tail.md | Adds thread.ring_buffer.retry_limit to the Tail input config table. |
| pipeline/inputs/opentelemetry.md | Adds thread.ring_buffer.retry_limit to the OpenTelemetry input config table. |
| pipeline/inputs/prometheus-textfile.md | Adds thread.ring_buffer.retry_limit to the Prometheus textfile input config table. |
| pipeline/inputs/blob.md | Adds thread.ring_buffer.retry_limit to the Blob input config table (but key prefix is inconsistent with adjacent entries). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@pipeline/inputs/blob.md`:
- Around line 24-26: The three ring buffer parameters must use the same
namespace; replace the incorrect parameter name thread.ring_buffer.retry_limit
with threaded.ring_buffer.retry_limit so all three read
threaded.ring_buffer.capacity, threaded.ring_buffer.window and
threaded.ring_buffer.retry_limit; update the occurrence of
thread.ring_buffer.retry_limit in blob.md to threaded.ring_buffer.retry_limit to
match the other inputs and maintain naming consistency.
0a251c6 to
ce45d76
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@pipeline/inputs/opentelemetry.md`:
- Line 45: Update the unit formatting in the description for
`thread.ring_buffer.retry_limit`: replace "100ms" with "100 ms" using a
non-breaking space so the number and unit stay together (i.e., change the text
in the table cell to use "100 ms"). Ensure only the formatting of the unit is
changed and the rest of the description remains unchanged.
In `@pipeline/inputs/prometheus-textfile.md`:
- Line 21: Update the text for the `thread.ring_buffer.retry_limit` description
to use a non‑breaking space between the number and unit: replace "100ms" with
"100\u00A0ms" so the unit follows the FluentBit.Units style guide and avoids
line breaks (target the description string containing
`thread.ring_buffer.retry_limit`).
In `@pipeline/inputs/tail.md`:
- Line 50: Update the unit formatting for the `thread.ring_buffer.retry_limit`
description by replacing the hard space in "100ms" with a non-breaking space so
it reads "100\u00A0ms" (or use the HTML entity ` ` if appropriate for the
Markdown renderer); locate the table cell containing the text "Each retry waits
100ms." and change it to "Each retry waits 100\u00A0ms." to comply with the
FluentBit.Units style guide.
92f8e47 to
963dfda
Compare
|
@jinyongchoi the patch for the other config threaded* parameter fix is now causing conflicts here, can you resolve? |
963dfda to
a69a897
Compare
Rebased on latest master to resolve conflicts caused by the threaded.* → thread.* parameter rename. |
eschabell
left a comment
There was a problem hiding this comment.
@jinyongchoi I'm not sure I see the need to use for the spacing? Can you remove that please?
a69a897 to
3e27ed9
Compare
Removed. Thanks for the feedback! |
eschabell
left a comment
There was a problem hiding this comment.
Looks good to me now, just waiting on code PR merge.
|
@jinyongchoi resolved the conflicts, waiting on code PR merge. |
Add documentation for the new 'thread.ring_buffer.retry_limit' configuration option to the following input plugin pages: - tail - opentelemetry - prometheus-textfile - blob This option controls the maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100ms (hardcoded). The default value is 10. Refs: fluent/fluent-bit#113934 Signed-off-by: jinyong.choi <inimax801@gmail.com>
f5c57b6 to
4551cf0
Compare
Rebased onto latest master to resolve the new conflicts from recent doc cleanups. Thanks! |
Add documentation for the new 'thread.ring_buffer.retry_limit' configuration option to the following input plugin pages:
This option controls the maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100ms (hardcoded). The default value is 10.
Refs: fluent/fluent-bit#11394
Summary by CodeRabbit